home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / telecomm / archivers / aucode.lha / AuEncode.DOC < prev    next >
Encoding:
Text File  |  1994-02-16  |  3.7 KB  |  92 lines
  1. NAME
  2.         AuEncode -  encode a binary file in text-only format for
  3.                     transmission via electronic mail.
  4.  
  5. SYNOPSIS
  6.  
  7.         AuEncode <infile >outfile [filename] [options]
  8.  
  9. DESCRIPTION
  10.  
  11.         The Amiga-Usenet Encode program will read a source file and encode
  12.         the raw binary data as printable ascii characters.  For the most
  13.         part, the encoded file will not be mangled by transmission via
  14.         electronic mail (we can recover from most typical Email mangling).
  15.         Thus, binary files may be safely sent via Email.
  16.  
  17.         Usage: AuEncode [<infile] [>outfile] [filename] [options]
  18.  
  19.             where  [<infile] = redirected input.  AuEncode reads from
  20.                                standard input (stdin).
  21.  
  22.                    [>outfile] = redirected output.  AuEncode writes encoded
  23.                                 output to standard output (stdout).
  24.  
  25.                    [filename] = specify the encoded filename.  Uuencoded
  26.                                 files contain a default target filename,
  27.                                 which is generally the same as the name of
  28.                                 the original input file.  The uuDEcoding
  29.                                 program will use this name as the default
  30.                                 output filename.  If you do not specify a
  31.                                 filename, AuEncode will assign one for you
  32.                                 ("AuEncode.out").
  33.  
  34.                    [options] = command line switches, listed below.
  35.  
  36.         AuEncode acts as a filter, reading from standard input, processing
  37.         the input stream, and writing the result to standard output.
  38.  
  39. OPTIONS
  40.  
  41.         -? or -h =  display a help message to stdout.  The help text may be
  42.                     redirected to a file or piped to More.
  43.  
  44.     -b<bufrsize> =  set the size of the input buffer.  The output buffer
  45.                     size will be adjusted accordingly.
  46.  
  47.                     Note that the program will recalculate the input buffer
  48.                     size using your supplied value as an upper bound.  This
  49.                     is because there is a fixed number of bytes encoded per
  50.                     output line, and it is most efficient to read a
  51.                     multiple of that fixed number.  For example, a
  52.                     <bufrsize> value of 1024 bytes will become 990 bytes
  53.                     (the default).
  54.  
  55.                     The size of the output buffer is calculated based on the
  56.                     actual size of the input buffer.
  57.  
  58.         -m<mode> =  file mode.  Unix systems use this to indicate
  59.                     read/write/execute file protections. Enter <mode> as a
  60.                     C style octal numeric value (i.e., with a leading
  61.                     zero).  The default value is 0644.
  62.  
  63.               -s =  status display.  The encoder will display the converted
  64.                     byte count (via stderr, not stdout) as encoding
  65.                     progresses.
  66.  
  67. NOTES
  68.  
  69.         The encoded file is approximately 40% larger than the original.
  70.         This is because each output byte contains only six bits worth of
  71.         original information.  Every three original bytes are stored in
  72.         four encoded bytes.  The encoded data is also stored as lines of
  73.         text.  Each line contains a length byte, a checksum byte, and a
  74.         newline character.  It all adds up.
  75.  
  76. REFERENCES
  77.  
  78.     AuDecode
  79.     uuencode
  80.     uudecode
  81.  
  82. ----------------------------------------------------------------------------
  83.  
  84. $Log:    AuEncode.DOC,v $
  85. Revision 1.2  94/02/15  21:47:19  CRH
  86. AuEncode document file.
  87.  
  88. Revision 1.1  93/09/15  21:45:07  CRH
  89. Initial revision
  90.  
  91. ----------------------------------------------------------------------------
  92.